home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / f90 / cvmg.z / cvmg
Encoding:
Text File  |  2002-10-03  |  6.6 KB  |  168 lines
  1. CVMG(3I)                                              Last changed: 4-13-99
  2.  
  3.  
  4. NNAAMMEE
  5.      CCVVMMGGMM, CCVVMMGGNN, CCVVMMGGPP, CCVVMMGGTT, CCVVMMGGZZ - Conditional vector merge functions
  6.  
  7. SSYYNNOOPPSSIISS
  8.      CCVVMMGGMM (([II==]_i,, [JJ==]_j,, [KK==]_k))
  9.  
  10.      CCVVMMGGNN (([II==]_i,, [JJ==]_j,, [KK==]_k))
  11.  
  12.      CCVVMMGGPP (([II==]_i,, [JJ==]_j,, [KK==]_k))
  13.  
  14.      CCVVMMGGTT (([II==]_i,, [JJ==]_j,, [KK==]_k))
  15.  
  16.      CCVVMMGGZZ (([II==]_i,, [JJ==]_j,, [KK==]_k))
  17.  
  18. IIMMPPLLEEMMEENNTTAATTIIOONN
  19.      UNICOS, UNICOS/mk, IRIX systems
  20.  
  21.      CF90, MIPSpro 7 Fortran 90
  22.  
  23. SSTTAANNDDAARRDDSS
  24.      Fortran extension
  25.  
  26. DDEESSCCRRIIPPTTIIOONN
  27.      At run time, _k is tested.  You can use the conditional vector merge
  28.      (CVMG) functions when an IIFF statement involving arrays prevents
  29.      vectorization of a loop.  The compiler can vectorize almost all such
  30.      loops, but these functions can be used in older codes.  Scalar
  31.      arguments can also be used with these functions.
  32.  
  33.      CVMG functions cannot be passed as arguments.  They are elemental
  34.      functions.
  35.  
  36.      These functions test for the following:
  37.  
  38.      * CCVVMMGGMM tests for minus (negative).  _i is returned if _k < 0.  _j is
  39.        returned if _k >= 0.
  40.  
  41.      * CCVVMMGGNN tests for nonzero.  _i is returned if _k is not equal to 0.  _j
  42.        is returned if _k = 0.
  43.  
  44.      * CCVVMMGGPP tests for positive or zero.  _i is returned if _k >= 0.  _j is
  45.        returned if _k < 0.
  46.  
  47.      * CCVVMMGGTT tests for true.  _i is returned if _k is true.  _j is returned if
  48.        _k is false.
  49.  
  50.      * CCVVMMGGZZ tests for zero.  _i is returned if _k = 0.  _j is returned if _k
  51.        is not equal to 0.
  52.  
  53.      These functions accept the following arguments:
  54.  
  55.      _i     Can be of type logical, Boolean, integer, real, or Cray pointer.
  56.  
  57.            See the RETURN VALUES section of this man page for more
  58.            information on how the type of _i affects the return value.
  59.  
  60.      _j     Can be of type logical, Boolean, integer, real, or Cray pointer.
  61.  
  62.            See the RETURN VALUES section of this man page for more
  63.            information on how the type of _j affects the return value.
  64.  
  65.      _k     Can be of type logical, Boolean, integer, real, or Cray pointer.
  66.  
  67.            See the RETURN VALUES section of this man page for more
  68.            information on how the type of _k affects the return value.
  69.  
  70.      If _k satisfies the condition tested by the function (for example, in
  71.      CCVVMMGGPP, if _k is positive), the first argument (_i) is returned as the
  72.      function result.  If _k does not satisfy the condition tested by the
  73.      function, _j is returned as the function result.
  74.  
  75.      For operands other than type logical, the vector merge functions are
  76.      not generic with respect to data typing.  They accept arithmetic
  77.      values of different types but interpret them as Boolean type (that is,
  78.      as bit patterns).  The returned function value is also Boolean.
  79.      Therefore, the function reference CCVVMMGGTT((11..00,,22..00,,..TTRRUUEE..)) is not type
  80.      real, with a value of 1.0, but a Boolean value that acts the same as
  81.      1.0 in a floating-point operation.
  82.  
  83.      A problem can arise if you assume that the function reference is type
  84.      real and use it in an expression or assignment that causes automatic
  85.      type conversion.  For example, if you use the function reference in a
  86.      context where an integer is needed, the result is not valid because
  87.      1.0 and 1 have different bit patterns.
  88.  
  89.      Because CVMG function values are Boolean, a binary operation involving
  90.      two CVMG functions uses integer arithmetic.  This can produce
  91.      unexpected results in assignments such as the following in which AA, BB,
  92.      CC, and DD are real:
  93.  
  94.           X = CVMGT(A,B,LOGIC1) + CVMGT(C,D,LOCIC2)
  95.                          ! Integer arithmetic, invalid results
  96.  
  97.      However, when used in an expression with another operand, a CVMG
  98.      function value takes on the type of the other operand, without any
  99.      explicit type conversion.  For example, the following expression uses
  100.      real arithmetic:
  101.  
  102.           X = 1.0 + CVMGT(2.0,3.0,LEXP)  ! Valid (types agree)
  103.  
  104.      The following suggestions explain how to prevent bugs when using these
  105.      functions:
  106.  
  107.      * Use only one CVMG function in a given expression.  If you use more
  108.        than one CVMG function in an expression, use explicit type
  109.        conversion.  This does not generate any additional code.  For
  110.        example:
  111.  
  112.           X = REAL(CVMGT(1.0,2.0,LTEST)) + REAL(CVMGT(X,Y,LTEST2))
  113.  
  114.      * Ensure that the assignment type matches the function argument.
  115.        Example:
  116.  
  117.          X = CVMGT(1.0,2.0,LTEST) ! Valid
  118.          X = REAL(CVMGT(1,2,LTEST)) ! Valid (uses explicit type conversion)
  119.          X = CVMGT(1,2,LTEST) ! Invalid (type mismatch)
  120.  
  121.      * Never use mixed typing in the first two arguments of a CCVVMMGGTT
  122.        function.  Example:
  123.  
  124.           CVMGT(1,2.0,LTEST)  ! DO NOT DO THIS
  125.  
  126.      The names of these intrinsics cannot be passed as arguments.
  127.  
  128. NNOOTTEESS
  129.      The CVMG intrinsic functions are outmoded.  Refer to the _F_o_r_t_r_a_n
  130.      _L_a_n_g_u_a_g_e _R_e_f_e_r_e_n_c_e _M_a_n_u_a_l, _V_o_l_u_m_e _3, for information on outmoded
  131.      features and their preferred standard alternatives.
  132.  
  133. RREETTUURRNN VVAALLUUEESS
  134.      For CCVVMMGGMM, CCVVMMGGNN, CCVVMMGGPP, CCVVMMGGTT, and CCVVMMGGZZ, the return value is either
  135.      type Boolean, logical, integer, or real, depending on the type of _i
  136.      and jj.
  137.  
  138.      On UNICOS and UNICOS/mk systems, type logical is returned if _i is of
  139.      type logical; otherwise it is of type Boolean.
  140.  
  141.      On IRIX systems, if _i and _j are both of type real, the result type is
  142.      also real.  If _i is of type logical, type logical is returned.  In all
  143.      other cases, the return value is of type integer.
  144.  
  145. EEXXAAMMPPLLEESS
  146.      Consider the following code:
  147.  
  148.           DO I = N,M
  149.              X(I) = A(I)
  150.              IF (B(I) .GT. C(I)) X(I) = D(I)
  151.           END DO
  152.  
  153.      This could be rewritten as follows:
  154.  
  155.           DO  I = N,M
  156.              X(I) = CVMGT(D(I), A(I), B(I).GT.C(I))
  157.           END DO
  158.  
  159.      The following rewrite would also be valid:
  160.  
  161.           DO I = N,M
  162.              X(I) = CVMGP( D(I), A(I), B(I) - C(I))
  163.           END DO
  164.  
  165. SSEEEE AALLSSOO
  166.      _I_n_t_r_i_n_s_i_c _P_r_o_c_e_d_u_r_e_s _R_e_f_e_r_e_n_c_e _M_a_n_u_a_l for the printed version of this
  167.      man page.
  168.